---
name: "pg_autoctl config check"
section: "1"
platform: "linux"
package: "pg-auto-failover-cli"
version: "2.2-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/pg_autoctl config check"
---

# pg\_autoctl config check(1)

pg\_autoctl config check pg\_autoctl config check - Check pg\_autoctl configuration

## NAME

pg\_autoctl config check - pg\_autoctl config check

pg\_autoctl config check - Check pg\_autoctl configuration

## SYNOPSIS

This command implements a very basic list of sanity checks for a pg\_autoctl node setup:

```
usage: pg_autoctl config check  [ --pgdata ] [ --json ]
--pgdata      path to data directory
--json        output data in the JSON format
```

## OPTIONS

- **--pgdata**

  Location of the Postgres node being managed locally. Defaults to the environment variable **PGDATA**. Use **--monitor** to connect to a monitor from anywhere, rather than the monitor URI used by a local Postgres node managed with **pg\_autoctl**.

- **--json**

  Output JSON formatted data.

## ENVIRONMENT

PGDATA

Postgres directory location. Can be used instead of the **--pgdata** option.

PG\_AUTOCTL\_MONITOR

Postgres URI to connect to the monitor node, can be used instead of the **--monitor** option.

XDG\_CONFIG\_HOME

The pg\_autoctl command stores its configuration files in the standard place XDG\_CONFIG\_HOME. See the *XDG Base Directory Specification*.

XDG\_DATA\_HOME

The pg\_autoctl command stores its internal states files in the standard place XDG\_DATA\_HOME, which defaults to **~/.local/share**. See the *XDG* *Base Directory Specification*.

## EXAMPLES

```
$ pg_autoctl config check --pgdata node1
18:37:27 63749 INFO  Postgres setup for PGDATA "/Users/dim/dev/MS/pg_auto_failover/tmux/node1" is ok, running with PID 5501 and port 99698
18:37:27 63749 INFO  Connection to local Postgres ok, using "port=5501 dbname=demo host=/tmp"
18:37:27 63749 INFO  Postgres configuration settings required for pg_auto_failover are ok
18:37:27 63749 WARN  Postgres 12.1 does not support replication slots on a standby node
18:37:27 63749 INFO  Connection to monitor ok, using "postgres://autoctl_node@localhost:5500/pg_auto_failover?sslmode=prefer"
18:37:27 63749 INFO  Monitor is running version "1.5.0.1", as expected
pgdata:                /Users/dim/dev/MS/pg_auto_failover/tmux/node1
pg_ctl:                /Applications/Postgres.app/Contents/Versions/12/bin/pg_ctl
pg_version:            12.3
pghost:                /tmp
pgport:                5501
proxyport:             0
pid:                   99698
is in recovery:        no
Control Version:       1201
Catalog Version:       201909212
System Identifier:     6941034382470571312
Latest checkpoint LSN: 0/6000098
Postmaster status:     ready
```

## AUTHOR

Microsoft

## COPYRIGHT

Copyright (c) Microsoft Corporation. All rights reserved.